API Help
EPLAN API
/
API Reference
/ Actions
Collapse All
Expand All
In This Topic
EPLAN API
Limitation of Liability
Help structure
User Guide
Development environment
EPLAN .Net API
API Framework
Scripts
Structure of a simple script
Simple script with parameters
Loading a script
Event handling in scripts
Adding menu points by a script
Add-ins
Creating add-ins in CSharp
Creating add-ins in Visual Basic.Net
Creating an add-in in VisualStudio
Shadow Copying API Assemblies
Actions
Calling actions
Automatic actions
Adding menu points
Using EPLAN in other applications
EPLAN API offline applications
EPLAN Remoting
Using other applications
Events
API DataModel
Creating or opening projects
Creating pages
Working with parts
Navigating the project data
DataModel overview
DataModel navigation overview
DMObjectsFinder overview
Filtering overview
Connections overview
MasterData ovierview
EObjects overview
Graphics overview
EPLAN properties
Project settings
Transactions
Locking
API Pro Panel
Creating 3D objects
Getting 3D objects
Transformations in 3D space
InstallationSpace
Component
Cabinet
MountingPanel
Plane
MountingRail
Area
Duct
PlaceHolder3D
Drilling
RoutingSegment
Connection3D
3D macros
ViewPlacement (model view in GUI)
Import/export 3D graphics
API Pre-planning
StructureSegment
SegmentDefinition
SegmentTemplate
PCTLoop
SegmentPlacement
Pre-planning macro
API Higher Electrotechnical services
Accessing selected objects
Displaying a preview
Placing window macros
API Electrotechnical services
Messages
Verifications
Interactions
API Miscellaneous
API Parts Selection Interface
API Parts Management Extension
How to display a MessageBox with the EPLAN window as owner
API Reports Modification Interface
API Labeling Modification Interface
Writing system messages
Throwing and catching exceptions
Trace output
Working with settings
Query user rights
Signing EPLAN assemblies
XMLProcessor
Command line parameters
API Reference
Assemblies
Eplan.EplApi.AFu Assembly
Eplan.EplApi.Baseu Assembly
Eplan.EplApi.DataModelu Assembly
Eplan.EplApi.EServicesu Assembly
Eplan.EplApi.Guiu Assembly
Eplan.EplApi.HEServicesu Assembly
Eplan.EplApi.MasterDatau Assembly
Eplan.EplApi.RemoteClientu Assembly
Eplan.EplApi.Remotingu Assembly
Eplan.EplApi.Starteru Assembly
Eplan.EplApi.Systemu Assembly
Actions
backup
changelayer
check
compress
CopyToolBarAction
devicelist
E21EasyImportSettingAction
edit
EsCorrectConnections
EplApiModuleAction
ExecuteScript
export
export3d
ExportNCData
ExportProductionWiring
ExportSegmentsTemplate
exportToGraphics
gedRedraw
generate
generatemacros
graphicallayertable
import
InsertModelViewAction
ImportPrePlanningData
ImportSegmentsTemplate
label
masterdata
MfExportToolbarAction
MfImportToolbarAction
MfRemoveToolbarAction
OpenWorkspaceAction
partslist
plcservice
print
ProjectAction
projectmanagement
ProjectOpen
RegisterCustomPropertyEditorAction
RegisterScript
renumber
reports
restore
SaveWorkspaceAction
search
selectionset
SetProjectLanguage
SpExportSubProject
SpImportSubProject
SwitchProjectType
synchronize
Topology
translate
UnregisterScript
UpdateSegmentsFilling
XAfActionSetting
XAfActionSettingProject
XCMRemoveUnnecessaryNDPsAction
XCMUniteNetDefinitionPointsAction
XDLInsertDeviceAction
XEGActionInsertSymRef
XEsSetPagePropertyAction
XEsSetProjectPropertyAction
XEsSetPropertyAction
XEsUserPropertiesExportAction
XEsUserPropertiesImportAction
XGedClosePage
XGedStartInteractionAction
XGedUpdateMacroAction
XMActionDCImport
XMActionDCCommonExport
XMDeleteReprTypeAction
XMExportConnectionsAction
XMExportFunctionAction
XMExportPagesAction
XPamSelectPart
XSDPreviewAction
XPamsDeviceSelectionAction
XPlaUpdateDetailAction
XPrjActionUpgradeProjects
XSettingsExport
XSettingsImport
Events
Eplan.EplApi.OnMainEnd
Eplan.EplApi.OnMainStart
Eplan.EplApi.OnPostOpenProject
Eplan.EplApi.OnUserPreCloseProject
onActionEnd.String.*
onActionStart.String.*
Ged.Redraw
NCSettingsMachineTools.Redraw
Page.ConnectionDirty
Project.CablingDirty
RefreshPageFilter
Interactions
XGedIaFormatDefPoints
XGedIaFormatGraphic
XGedIaFormatSymbol
XGedIaFormatText
XMIaInsertMacro
XML Converters
Category DeviceListXmlConverter
XDLCsvCommaSepImporterExporter
XDLCsvImporterExporter
XDLTxtImporterExporter
XDLXmlExporter
Category LanguageDbXmlConverter
XTrLanguageDbXml2E21UnicodeTabConverter
XTrLanguageDbXml2TabConverterImpl
Category PartsListXmlConverter
XPalCSVConverter
XPalXmlExporter
Category XPamExport
IXPartsImportExportEdz
XPamExportXml
Category XPamImport
XPamImportXml
Category PLCXmlConverter
PlcDcExchangerMitsubishiAML
PlcDcExchangerSiemensTIAAML
PlcDcXMLExchangerABB
PlcDcXMLExchangerBandR
PlcDcXMLExchangerBeckhoff
PlcDcXMLExchangerCodesys
PlcDcXMLExchangerLogiCals
PlcDcXMLExchangerMitsubishi
PlcDcXmlExchangerRexroth
PlcDCXmlExchangerSchneider
PlcDcXMLExchangerSiemens
PlcDcXMLExchangerUniversal
XMLRockwellExchanger
Actions
In This Topic
This is the list of all official EPLAN API actions available for the user.
backup
changelayer
check
compress
CopyToolBarAction
devicelist
E21EasyImportSettingAction
edit
EsCorrectConnections
EplApiModuleAction
ExecuteScript
export
export3d
ExportNCData
ExportProductionWiring
ExportSegmentsTemplate
exportToGraphics
gedRedraw
generate
generatemacros
graphicallayertable
import
InsertModelViewAction
ImportPrePlanningData
ImportSegmentsTemplate
label
masterdata
MfExportToolbarAction
MfImportToolbarAction
MfRemoveToolbarAction
OpenWorkspaceAction
partslist
plcservice
print
ProjectAction
projectmanagement
ProjectOpen
RegisterCustomPropertyEditorAction
RegisterScript
renumber
reports
restore
SaveWorkspaceAction
search
selectionset
SetProjectLanguage
SpExportSubProject
SpImportSubProject
SwitchProjectType
synchronize
Topology
translate
UnregisterScript
UpdateSegmentsFilling
XAfActionSetting
XAfActionSettingProject
XCMRemoveUnnecessaryNDPsAction
XCMUniteNetDefinitionPointsAction
XDLInsertDeviceAction
XEGActionInsertSymRef
XEsSetPagePropertyAction
XEsSetProjectPropertyAction
XEsSetPropertyAction
XEsUserPropertiesExportAction
XEsUserPropertiesImportAction
XGedClosePage
XGedStartInteractionAction
XGedUpdateMacroAction
XMActionDCImport
XMActionDCCommonExport
XMDeleteReprTypeAction
XMExportConnectionsAction
XMExportFunctionAction
XMExportPagesAction
XPamSelectPart
XSDPreviewAction
XPamsDeviceSelectionAction
XPlaUpdateDetailAction
XPrjActionUpgradeProjects
XSettingsExport
XSettingsImport
